-
Notifications
You must be signed in to change notification settings - Fork 1
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Start documentation #43
Start documentation #43
Conversation
Pull Request Test Coverage Report for Build 8894751703Details
💛 - Coveralls |
Pull Request Test Coverage Report for Build 8921471274Warning: This coverage report may be inaccurate.This pull request's base commit is no longer the HEAD commit of its target branch. This means it includes changes from outside the original pull request, including, potentially, unrelated coverage changes.
Details
💛 - Coveralls |
391da59
to
d6baaa9
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
That is quite a sophisticated start @lukaspie, I have not much to comment here, mainly focusing on other work at the moment some points catched my thoughts though:
- You have currently some documentation still on the repo's README.md and some already in the doc, do you plan to remove most in the README.md cuz single source principle could be the README is just the link to the doc and maybe here its getting started page
- I like that you picked up some of the work and thoughts from EM I also like the individual acknowledgements for examples in the reference page
To me this reads ready for a first release as it is meaty enough to be discussed by XPS experts and the community
I removed some parts from the README now and replaced them by a link to the docs. For the individual examples, I kept the README, so people can see them immediately in the repo as well. Maybe eventually the docs could also just usethe README files to populate the docs (or vice-versa). |
No description provided.